The AI Assistant
WebWorks Reverb 2.0 can embed a chat-style AI Assistant directly in your output, integrated into the Reverb Menu alongside the Table of Contents and Index. The Assistant is powered by the WebWorks Platform: you create an Assistant on the Platform, connect your target to it, and upload the knowledge base ePublisher generates so the Assistant answers from your published help.
For the setup steps, see Getting Started with the WebWorks Platform. It covers the ePublisher side and links to the WebWorks Platform help for creating the Assistant, uploading the Knowledge Files, and putting the Assistant in deployment.
Generate Assistant
Located in AI Features settings. Set to Enable to embed the AI Assistant. An AI Assistant button and tab are added to the Reverb 2.0 menu, alongside the Contents and Index buttons.
Assistant ID
Located in AI Features settings. The unique ID (a GUID) of the WebWorks Platform Assistant this output connects to. Create the Assistant on the Platform, then paste its Assistant ID here.
Hide AI Tab when file local
Located in AI Features settings. When enabled, the AI Assistant tab is hidden at runtime if the output is opened over the file: protocol, but remains visible and functional when served over http: or https:. This lets a single generated artifact be bundled locally and also mirrored to a public web server.
When the Assistant Cannot Load
On a served site, when the Platform refuses the Assistant or cannot be reached, the Assistant tab shows an Assistant Unavailable notice with the reason, for example that the Assistant is not in deployment, that the site's domain is not one of its Origin Domains, or that the Assistant ID is incorrect. The notice has no conversation starters and no input box.
On a local file or
localhost, the tab shows a placeholder assistant marked "Preview only". It answers every message locally with setup steps and sends nothing. The placeholder also appears when the target has no Assistant ID, which lets you review the chat's look before you connect an Assistant.
Each message means the following:
What readers see | What it means |
|---|---|
Assistant Unavailable, "This assistant is not available." | In Deployment is off on the Platform. Turn it on. |
Assistant Unavailable, "Origin not allowed" | The site's domain is not listed under Origin Domains. Add the bare domain. |
Assistant Unavailable, "This assistant could not be found. The Assistant ID may be incorrect." | The Assistant ID in the target settings does not match an Assistant. Copy the ID from the Assistant on the Platform again, and regenerate the target. |
Assistant Unavailable, "The assistant is unavailable right now." | Another problem, such as a network failure. The browser console shows the full detail. |
A placeholder assistant marked "Preview only" | The page was opened from a local file or |
The first two messages come from the Platform. The browser console carries the full detail behind each of them. For the Platform settings involved, see The Assistant doesn't appear or doesn't answer in the WebWorks Platform help.
Links in the Assistant's answers open help pages within the help, and open other sites in a new browser tab.
The Assistant's Avatar
Wherever the Assistant is represented in the chat — the welcome screen, each reply, the thinking indicator, the streaming reply, and the conversation-list header — Reverb 2.0 shows the avatar configured for the Assistant on the WebWorks Platform. If the Assistant has no avatar, or if its avatar image cannot be loaded, the chat shows the generic assistant icon instead, so an Assistant without an avatar looks exactly as it did before.
The avatar belongs to the Assistant, not to the generated output, so there is no target setting for it and no need to regenerate. Set it on the Platform and published output picks it up the next time a reader opens the chat. For the steps, see Create and manage an Assistant in the WebWorks Platform help; to style it, see Customizing the AI Assistant Avatar.